/*******************************************************************************************
 * Copyright (c) 2006-2009 Alex Robson, Rob Simmons, Craig Israel, and Rachel Twyford
 *
 * Use of this software in any form requires that you have both 
 * read and agreed to the following terms:
 *
 * Permission is hereby granted, free of charge, to any person obtaining
 * a copy of this software and associated documentation files (the "Software"), 
 * to deal in the Software without restriction, including without limitation 
 * the rights to use, copy, modify, merge, publish, distribute, sublicense, 
 * and/or sell copies of the Software, and to permit persons to whom the
 * Software is furnished to do so, subject to the following conditions: 
 *
 * Redistributions of source code must retain the above copyright
 * notice, this list of conditions and the following disclaimer.
 * Redistributions in binary form must reproduce the above copyright notice, 
 * this list of conditions and the following disclaimer in the 
 * documentation and/or other materials provided with the distribution.
 * Neither the name of Nvigorate nor the names of its contributors may 
 * be used to endorse or promote products derived from this software without 
 * specific prior written permission. 
 *
 * THIS SOFTWARE IS PROVIDED "AS IS" AND ANY
 * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
 * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE 
 * DISCLAIMED. IN NO EVENT SHALL ANY CONTRIBUTOR BE LIABLE FOR ANY
 * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
 * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; 
 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
 * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS 
 * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 * ****************************************************************************************/

using System.Collections.Generic;
using Nvigorate.Common;

namespace Nvigorate.Relational.State
{
    public interface IPersistenceState
    {
        /// <summary>
        /// A list of properties that changed in this instance since initialization
        /// </summary>
        List<Tuple<string, object>> ChangedValues { get; set; }

        /// <summary>
        /// A flag to indicate that there are changed property values in this instance
        /// </summary>
        bool IsDirty { get; }

        /// <summary>
        /// A flag to indicate that this object is a new instance/new record for the repository
        /// </summary>
        bool IsNew { get; }

        /// <summary>
        /// A list of property names which uniquely identifiy each instance of this type
        /// </summary>
        List<string> Keys { get; set; }

        /// <summary>
        /// A list of record sources (tables) that were used to populate this instance
        /// </summary>
        List<string> Loaded { get; set; }

        /// <summary>
        /// Lets the repository know that this record has a relationship change
        /// that needs to be persisted to the database
        /// </summary>
        bool RelationshipChanged { get; set; }

        /// <summary>
        /// Indicates which repository this instance was populated from
        /// </summary>
        string RepositoryName { get; set; }

        /// <summary>
        /// Adds the name of a property that changed in this instance since instantation
        /// to the list of changed properties (<see cref="ChangedValues"/>)
        /// </summary>
        /// <param name="changedPropertyName"></param>
        /// <param name="originalValue"></param>
        void AddChangedValue(string changedPropertyName, object originalValue);

        /// <summary>
        /// Returns the original value given the property name.
        /// Uses reflection to return the property value if there is no change.
        /// </summary>
        /// <param name="propertyName"></param>
        /// <param name="instance"></param>
        /// <returns></returns>
        object GetOriginalValue(string propertyName, object instance);

        void ClearDirtyState();

        void ForceInsert();
    }
}